home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 25 / Cream of the Crop 25.iso / bbs / utilz20x.zip / HKEYS / HKEYS.DOC < prev    next >
Text File  |  1997-01-21  |  6KB  |  118 lines
  1.  
  2.     ▐███████▐█▌             ███████▌███▐█████████▌ ███████▌██ ▄████████▄
  3.     ▐███████▐██            ▐███████▌██▌▐███████▐██▐███████▌██▐████▐█████
  4.     ▐███████▐██            ▐███████▌██ ▐███████▐██▐███████▌██▐████
  5.     ▐███████▐██            ▐███████▌██ ▐███████▄▄ ▐███████▌██▐████████▄
  6.     ▐██████████ ███████████▐█████████▌ ▐███████▀▀ ▐██████████ ▀▀▀▀▀█████
  7.     ▐███████▐██            ▐███████▌██▌▐███████▐██ █████████▌▐████▌█████
  8.     ▐███████▐██            ▐███████▌███▐██████████ ▐███████   ▀███████▀  v1.0
  9. ─────────────────────────────────────────────────────────────────────────────
  10.  
  11.  
  12.           [Topic]                                      [Keyword]
  13.  
  14.           Overview ................................... /OVERVIEW
  15.           Installation ............................... /INSTALL
  16.           Program Usage .............................. /USAGE
  17.           Caveat Emptor .............................. /DISCLAIMER
  18.           Getting in Touch ........................... /CONTACT
  19.  
  20.  
  21.   o v e r v i e w                                                   /OVERVIEW
  22.   ───────────────────────────────────────────────────────────────────────────
  23.  
  24.   How many times have you wished that ProBoard would let you use the special
  25.   keys like Escape and Return in your menus as hotkeys? How may different
  26.   things have you tried? How many of them worked? Ah, none probably. Well,
  27.   this little gem here is a program which will enable you to use escape and
  28.   return as regular hotkeys in your menus.
  29.  
  30.   This is not a pex, nor it is a compilcated application. Interestingly
  31.   enough, ProBoard recognizes the Escape and Return as valid hotkeys itself.
  32.   The bad news is (was) that there was no way to put those keys using the
  33.   menu editor. So what hKeys does, is simply to create menu items with the
  34.   hotkey data already set for you. You simply fill in the blanks.
  35.  
  36.  
  37.   i n s t a l l a t i o n                                            /INSTALL
  38.   ───────────────────────────────────────────────────────────────────────────
  39.  
  40.   Put hKeys.Exe somewhere in your path. You will probably want to use it
  41.   over and over again (or maybe not). The program is tiny (10k) and does not
  42.   occupy much space on your hard dirve. So, copy it somewhere where you can
  43.   access it by simply typing 'hkeys' on the command prompt.
  44.  
  45.   You must have the PROBOARD environment set to point to your bbs system
  46.   directory as per the User's Manual that came with your copy of ProBoard.
  47.   This variable is used by hKeys to locate the MENUS subdirectory where all
  48.   your menu files are located.
  49.  
  50.   This is it. Run hKeys without any parameters to get a quick reference.
  51.  
  52.  
  53.   p r o g r a m   u s a g e                                            /USAGE
  54.   ───────────────────────────────────────────────────────────────────────────
  55.  
  56.   Generally, you need to specify at least two parameters for hKeys to work:
  57.  
  58.                   hkeys menu_file -return | -escape
  59.  
  60.   The first one is the name of the menu file(s) you want to modify. Note that
  61.   you only need to specify the names that you see in the ProBoard menu editor
  62.   (like GLOBAL, TOP, etc.). You can also use wildcards to specify multiple
  63.   menu files. See the examples below of proper wildcard usage.
  64.  
  65.   The other thing you need to specify is the hotkey for the item that you
  66.   will be creating. You can use '-return or -r' to create an item with the
  67.   Return hotkey, and '-escape or -e' to create an item with an Escape key.
  68.   You can specify both, in which case two items will be created: one for the
  69.   Return and one for the Escape keys. You must specify at least one of these.
  70.  
  71.   Examples:
  72.       hkeys top -r        : add a return hotkey item to the TOP menu
  73.       hkeys global -r -e  : add return and escape items to the GLOBAL menu
  74.       hkeys * -escape     : add an escape hotkey item to all menus
  75.  
  76.   hKeys simply appends one or more menu items to your already existing menus
  77.   (note that the menus must have already been created with ProCFG before you
  78.   run hKeys as this program will not make menus from scratch). The menu items
  79.   that it creates are the same as the default ProBoard items - all fields
  80.   except for the hotkey and the text line. The text in the text field will
  81.   be as follows:
  82.  
  83.       "(escape) key item [generated by hKeys]"  <- Escape is the hotkey
  84.       "(return) key item [generated by hKeys]"  <- Return is the hotkey
  85.  
  86.   You can safely delete this text as it is for identification purposes only
  87.   and then edit the rest of the menu item like you normally would (without
  88.   touching the hotkey, of course). Note that appending the item at the end
  89.   of the menu is only a minor inconvenience if you want to posistion it
  90.   differently. To move it, use the Copy and Paste functions of the ProBoard
  91.   menu editor.
  92.  
  93.  
  94.   c a v e a t   e m p t o r                                       /DISCLAIMER
  95.   ───────────────────────────────────────────────────────────────────────────
  96.  
  97.   hKeys uses an undocumented quirk of ProBoard to do its magic. Even though
  98.   all versions up to v2.16b3 work with this scheme, I cannot guarantee that
  99.   any of the future versions will. Use at your own risk. I am also not
  100.   responsible for any corrupted menu (or other) files and data. Prudence
  101.   dictates that you backup all files before attempting to modify them. I
  102.   have used every precaution that I can possibly think of to prevent errors
  103.   in this program, but I will not be liable for any damages its use or
  104.   inability to use may cause you. For the full text of your License, read
  105.   the file 'Copying.Doc' included with this manual.
  106.  
  107.   The source code (hKeys.Cpp) requires PB-Lib v3.0 or later to compile.
  108.   This library is available separately from the same source as hKeys itself.
  109.  
  110.  
  111.   g e t t i n g   i n   t o u c h                                    /CONTACT
  112.   ───────────────────────────────────────────────────────────────────────────
  113.  
  114.   Due to the lengthy nature of this topic, it is now located in a separate
  115.   file called 'Support.Doc' (included with this manual). Please, do not
  116.   hesitate to contact me if you have problems, questions or suggestions.
  117.  
  118.